Vcenter Identity Providers ActiveDirectoryOverLdap

Vcenter Identity Providers ActiveDirectoryOverLdap

The Vcenter Identity Providers ActiveDirectoryOverLdap schema contains the information about to how to use an Active Directory over LDAP connection to allow searching for users and groups if the identity provider is an On-Prem service.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "user_name": "string",
    "password": "string",
    "users_base_dn": "string",
    "groups_base_dn": "string",
    "server_endpoints": [
        "string"
    ],
    "cert_chain": {
        "cert_chain": [
            "string"
        ]
    }
}

string

user_name

Required

User name to connect to the active directory server.

This property was added in vSphere API 7.0.0.0.

string As password As password

password

Required

Password to connect to the active directory server.

This property was added in vSphere API 7.0.0.0.

string

users_base_dn

Required

Base distinguished name for users

This property was added in vSphere API 7.0.0.0.

string

groups_base_dn

Required

Base distinguished name for groups

This property was added in vSphere API 7.0.0.0.

array of string

server_endpoints

Required

Active directory server endpoints. At least one active directory server endpoint must be set.

This property was added in vSphere API 7.0.0.0.

cert_chain

Optional

SSL certificate chain in base64 encoding.

This property was added in vSphere API 7.0.0.0.

This property can be missing or null only, if all the active directory server endpoints use the LDAP (not LDAPS) protocol.